Observation Resource Implementation
Reference: http://hl7.org/fhir/R4/observation.html
| Element / Node Names | Description |
|---|
| code | Codes and names of observation |
| id | Business identifier for observation |
| issued | Date/Time this version was made available |
| meta | Information regarding the FHIR element |
| note | The notes and comments that accompany a result |
| referenceRange | Provides guide for interpretation |
| resourceType | Represents the FHIR domain resource type |
| performer | Producer i.e., the lab that performed the testing which was reported to Eclair in OBX.15. If not provided, this will be the lab that sent the report, taken from the sending facility. If the sending facility has been given a name in Eclair, this should be present in the performer as the display text (name for the producer is not currently implemented) |
| status | Shows the status of the observation, i.e. this could be registered, preliminary, final, amended, |
| value quantity/string | Shows the value / result of the observation |
| interpretation | Assessment of the observation value, see Interpretation/Abnormal Flags in the configuration section |
| subject | Reference to the patient |
Query Parameters
The following parameters are supported for performing queries on FHIR Patient resource. See http://hl7.org/fhir/R4/searchparameter-registry.html for further information.
| Data | Parameter |
|---|
| Search parameters | Internal patient ID |
| NHI |
| Test or Procedure code in LOINC or NZPOCs |
| Partial patient name |
| Filter Criteria | Date range |
| 1 or more External Observation codes (Standard test or procedure code e.g. NZPOCS) |
| 1 or more Local Observation code (Local test or procedure code in LOINC) |
| Limit by count | number of resources to be returned |
| Sort by order of | date, ascending or descending |
Examples by Use Case
| Use Cases | Examples |
|---|
| Retrieve all diagnostic reports for a given patient | GET \https://reg\-eclairfhir\-api\-v40\-acc\.au\-s1\.cloudhub\.io/clinicaldocrepo/Eclair/Observation?patient\.identifier=standards\.digital\.health\.nz/ns/nhi\-id%7CZKE5509&\_Rsort\-date&\_include=Observation:Results |
| Retrieve all Observation for a patient by LOINC code. Sort by date | \{\{host\}\}/clinicaldocrepo/Eclair/Observation?patient\.identifier=standards\.digital\.health\.nz/ns/nhi\-id%7CZKG6972&\_Rsort\-date&\_include=Observation:Results&code=718\-7 |
| Retrieve all Observation for a patient by External code (e.g., 1003). Sort by date | GET \{\{host\}\}/clinicaldocrepo/Eclair/Observation?patient\.identifier=standards\.digital\.health\.nz/ns/nhi\-id%7CZKG6972&\_Rsort\-date&code=1003 |
| Retrieve all Observation for a patient by Local code (e.g., LTAFBE). Sort by date | GET \{\{host\}\}/clinicaldocrepo/Eclair/Observation?patient\.identifier=standards\.digital\.health\.nz/ns/nhi\-id%7CZKG6972&\_Rsort\-date&code=MLS%7CLTAFBE |
| Retrieve most recent Observation for a NHI / single code | GET \https://reg\-eclairfhir\-api\-v40\-acc\.au\-s1\.cloudhub\.io/clinicaldocrepo/Eclair/Observation?patient\.identifier=standards\.digital\.health\.nz%2Fns%2Fnhi\-id%7CZKG6972&code=718\-7&\_sort=rdate&\_count=1 |
| Retrieve Observation by Date between 2 dates | GET \https://reg\-eclairfhir\-api\-v40\-acc\.au\-s1\.cloudhub\.io/clinicaldocrepo/Eclair/Observation?patient\.identifier=standards\.digital\.health\.nz%2Fns%2Fnhi\-id%7CZKG6972&date=gt2023\-06\-02&date=lt2023\-06\-03 |
Sample payloads
Request payload
GET https://reg-eclairfhir-api-v40-acc.au-s1.cloudhub.io/clinicaldocrepo/Eclair/Observation?subject.identifier=standards.digital.health.nz/ns/nhi-id%7CZZZ0032&code=718-7&_sort=-date&_count=1
Response payload
{
"resourceType": "Bundle",
"meta": {
"lastUpdated": "2023-09-29T12:49:09.2078293+13:00"
},
"type": "searchset",
"entry": [
{
"fullUrl": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Observation/APHDELPHIC|1030BE100000|1003",
"resource": {
"resourceType": "Observation",
"id": "9cdfd6f1-c168-4d91-8723-497e8ea19268",
"meta": {
"lastUpdated": "2016-07-21T08:59:00+12:00"
},
"status": "final",
"code": {
"coding": [
{
"system": "https://eclair.hanz.health.nz/Eclair/Admin/OrderConfiguration/ModifyObservations.asp?ObscObsid=1003&ObscObsidSch=APHDE7",
"code": "1003",
"display": "Hb - Haemoglobin"
},
{
"system": "http://loinc.org/718-7",
"code": "718-7",
"display": "Hb - Haemoglobin"
}
]
},
"subject": {
"reference": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Patient/ECLAIRSYSTEM|3131151"
},
"effectiveDateTime": "2023-08-31T10:53:00+12:00",
"issued": "2016-07-21T08:59:00+12:00",
"performer": [
{
"reference": "APHDELPHIC",
"display": "Auckland Healthcare"
}
],
"valueQuantity": {
"value": 88.0,
"unit": "g/L"
},
"interpretation": [
{
"coding": [
{
"system": "http://hl7.org/fhir/ValueSet/observation-interpretation",
"code": "L"
}
],
"text": "Low"
}
],
"referenceRange": [
{
"text": "130-175"
}
]
},
"search": {
"mode": "match"
}
}
]
}